Meshtastic App/com.geeksville.mesh/[androidJvm]MeshProtos/User

User

class User : GeneratedMessage, MeshProtos.UserOrBuilder


Broadcast when a newly powered mesh node wants to find a node num it can use
Sent from the phone over bluetooth to set the user id for the owner of this node.
Also sent from nodes to each other when a new node signs on (so all clients can have this info)
The algorithm is as follows:
when a node starts up, it broadcasts their user and the normal flow is for all
other nodes to reply with their User as well (so the new node can build its nodedb)
If a node ever receives a User (not just the first broadcast) message where
the sender node number equals our node number, that indicates a collision has
occurred and the following steps should happen:
If the receiving node (that was already in the mesh)'s macaddr is LOWER than the
new User who just tried to sign in: it gets to keep its nodenum.
We send a broadcast message of OUR User (we use a broadcast so that the other node can
receive our message, considering we have the same id - it also serves to let
observers correct their nodedb) - this case is rare so it should be okay.
If any node receives a User where the macaddr is GTE than their local macaddr,
they have been vetoed and should pick a new random nodenum (filtering against
whatever it knows about the nodedb) and rebroadcast their User.
A few nodenums are reserved and will never be requested:
0xff - broadcast
0 through 3 - for future use

Protobuf type meshtastic.User

Types

Builder

class Builder : GeneratedMessage.Builder<BuilderT> , MeshProtos.UserOrBuilder


Broadcast when a newly powered mesh node wants to find a node num it can use
Sent from the phone over bluetooth to set the user id for the owner of this node.
Also sent from nodes to each other when a new node signs on (so all clients can have this info)
The algorithm is as follows:
when a node starts up, it broadcasts their user and the normal flow is for all
other nodes to reply with their User as well (so the new node can build its nodedb)
If a node ever receives a User (not just the first broadcast) message where
the sender node number equals our node number, that indicates a collision has
occurred and the following steps should happen:
If the receiving node (that was already in the mesh)'s macaddr is LOWER than the
new User who just tried to sign in: it gets to keep its nodenum.
We send a broadcast message of OUR User (we use a broadcast so that the other node can
receive our message, considering we have the same id - it also serves to let
observers correct their nodedb) - this case is rare so it should be okay.
If any node receives a User where the macaddr is GTE than their local macaddr,
they have been vetoed and should pick a new random nodenum (filtering against
whatever it knows about the nodedb) and rebroadcast their User.
A few nodenums are reserved and will never be requested:
0xff - broadcast
0 through 3 - for future use

Protobuf type meshtastic.User

Properties

HW_MODEL_FIELD_NUMBER

val HW_MODEL_FIELD_NUMBER: Int = 5

ID_FIELD_NUMBER

val ID_FIELD_NUMBER: Int = 1

IS_LICENSED_FIELD_NUMBER

val IS_LICENSED_FIELD_NUMBER: Int = 6

IS_UNMESSAGABLE_FIELD_NUMBER

val IS_UNMESSAGABLE_FIELD_NUMBER: Int = 9

LONG_NAME_FIELD_NUMBER

val LONG_NAME_FIELD_NUMBER: Int = 2

MACADDR_FIELD_NUMBER

val MACADDR_FIELD_NUMBER: Int = 4

PUBLIC_KEY_FIELD_NUMBER

val PUBLIC_KEY_FIELD_NUMBER: Int = 8

ROLE_FIELD_NUMBER

val ROLE_FIELD_NUMBER: Int = 7

SHORT_NAME_FIELD_NUMBER

val SHORT_NAME_FIELD_NUMBER: Int = 3

Functions

copy

inline fun MeshProtos.User.copy(block: UserKt.Dsl.() -> Unit): MeshProtos.User

equals

open fun equals(obj: Any): Boolean

getDefaultInstance

open fun getDefaultInstance(): MeshProtos.User

getDefaultInstanceForType

open fun getDefaultInstanceForType(): MeshProtos.User

getDescriptor

fun getDescriptor(): Descriptors.Descriptor

getHwModel

open fun getHwModel(): MeshProtos.HardwareModel


TBEAM, HELTEC, etc...
Starting in 1.2.11 moved to hw_model enum in the NodeInfo object.
Apps will still need the string here for older builds
(so OTA update can find the right image), but if the enum is available it will be used instead.

.meshtastic.HardwareModel hw_model = 5;

getHwModelValue

open fun getHwModelValue(): Int


TBEAM, HELTEC, etc...
Starting in 1.2.11 moved to hw_model enum in the NodeInfo object.
Apps will still need the string here for older builds
(so OTA update can find the right image), but if the enum is available it will be used instead.

.meshtastic.HardwareModel hw_model = 5;

getId

open fun getId(): String


A globally unique ID string for this user.
In the case of Signal that would mean +16504442323, for the default macaddr derived id it would be !<8 hexidecimal bytes>.
Note: app developers are encouraged to also use the following standard
node IDs "^all" (for broadcast), "^local" (for the locally connected node)

string id = 1;

getIdBytes

open fun getIdBytes(): ByteString


A globally unique ID string for this user.
In the case of Signal that would mean +16504442323, for the default macaddr derived id it would be !<8 hexidecimal bytes>.
Note: app developers are encouraged to also use the following standard
node IDs "^all" (for broadcast), "^local" (for the locally connected node)

string id = 1;

getIsLicensed

open fun getIsLicensed(): Boolean


In some regions Ham radio operators have different bandwidth limitations than others.
If this user is a licensed operator, set this flag.
Also, "long_name" should be their licence number.

bool is_licensed = 6;

getIsUnmessagable

open fun getIsUnmessagable(): Boolean


Whether or not the node can be messaged

optional bool is_unmessagable = 9;

getLongName

open fun getLongName(): String


A full name for this user, i.e. "Kevin Hester"

string long_name = 2;

getLongNameBytes

open fun getLongNameBytes(): ByteString


A full name for this user, i.e. "Kevin Hester"

string long_name = 2;

getMacaddr

open fun ~~getMacaddr~~(): ByteString


Deprecated in Meshtastic 2.1.x
This is the addr of the radio.
Not populated by the phone, but added by the esp32 when broadcasting

bytes macaddr = 4 [deprecated = true];

getParserForType

open fun getParserForType(): Parser<MeshProtos.User>

getPublicKey

open fun getPublicKey(): ByteString


The public key of the user's device.
This is sent out to other nodes on the mesh to allow them to compute a shared secret key.

bytes public_key = 8;

getRole

open fun getRole(): ConfigProtos.Config.DeviceConfig.Role


Indicates that the user's role in the mesh

.meshtastic.Config.DeviceConfig.Role role = 7;

getRoleValue

open fun getRoleValue(): Int


Indicates that the user's role in the mesh

.meshtastic.Config.DeviceConfig.Role role = 7;

getSerializedSize

open fun getSerializedSize(): Int

getShortName

open fun getShortName(): String


A VERY short name, ideally two characters.
Suitable for a tiny OLED screen

string short_name = 3;

getShortNameBytes

open fun getShortNameBytes(): ByteString


A VERY short name, ideally two characters.
Suitable for a tiny OLED screen

string short_name = 3;

hashCode

open fun hashCode(): Int

hasIsUnmessagable

open fun hasIsUnmessagable(): Boolean


Whether or not the node can be messaged

optional bool is_unmessagable = 9;

isInitialized

fun isInitialized(): Boolean

newBuilder

open fun newBuilder(): MeshProtos.User.Builder

open fun newBuilder(prototype: MeshProtos.User): MeshProtos.User.Builder

newBuilderForType

open fun newBuilderForType(): MeshProtos.User.Builder

parseDelimitedFrom

open fun parseDelimitedFrom(input: InputStream): MeshProtos.User

open fun parseDelimitedFrom(input: InputStream, extensionRegistry: ExtensionRegistryLite): MeshProtos.User

parseFrom

open fun parseFrom(data: Array<Byte>): MeshProtos.User

open fun parseFrom(data: ByteString): MeshProtos.User

open fun parseFrom(input: CodedInputStream): MeshProtos.User

open fun parseFrom(input: InputStream): MeshProtos.User

open fun parseFrom(data: ByteBuffer): MeshProtos.User

open fun parseFrom(data: Array<Byte>, extensionRegistry: ExtensionRegistryLite): MeshProtos.User

open fun parseFrom(data: ByteString, extensionRegistry: ExtensionRegistryLite): MeshProtos.User

open fun parseFrom(input: CodedInputStream, extensionRegistry: ExtensionRegistryLite): MeshProtos.User

open fun parseFrom(input: InputStream, extensionRegistry: ExtensionRegistryLite): MeshProtos.User

open fun parseFrom(data: ByteBuffer, extensionRegistry: ExtensionRegistryLite): MeshProtos.User

parser

open fun parser(): Parser<MeshProtos.User>

toBuilder

open fun toBuilder(): MeshProtos.User.Builder

writeTo

open fun writeTo(output: CodedOutputStream)